/*	
 *  Copyright (c) 2009-@year@. The GUITAR group at the University of Maryland. Names of owners of this group may
 *  be obtained by sending an e-mail to atif@cs.umd.edu
 * 
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
 *  documentation files (the "Software"), to deal in the Software without restriction, including without 
 *  limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *	the Software, and to permit persons to whom the Software is furnished to do so, subject to the following 
 *	conditions:
 * 
 *	The above copyright notice and this permission notice shall be included in all copies or substantial 
 *	portions of the Software.
 *
 *	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
 *	LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 
 *	EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
 *	IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR 
 *	THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 */
package edu.umd.cs.emut.event;

import java.util.HashSet;
import java.util.Set;

import edu.umd.cs.emut.model.EComponent;

/**
 * 
 * @author <a href="mailto:baonn@cs.umd.edu"> Bao N. Nguyen </a>
 * 
 */
public abstract class EEvent {

	/**
	 * List of event available
	 */
	static Set<Class<? extends EEvent>> eventList = new HashSet<Class<? extends EEvent>>();

	/**
	 * Register an event
	 * <p>
	 * 
	 * @param event
	 * @return
	 * @see java.util.Set#add(java.lang.Object)
	 */
	public static boolean register(Class<? extends EEvent> event) {
		return eventList.add(event);
	}

	/**
	 * @return the eventList
	 */
	public static Set<Class<? extends EEvent>> getEventList() {
		return eventList;
	}

	/**
	 * @param o
	 * @return
	 * @see java.util.Set#remove(java.lang.Object)
	 */
	public static boolean unregister(Class<? extends EEvent> event) {
		return eventList.remove(event);
	}

	/**
	 * Perform the event on a component
	 * 
	 * <p>
	 * 
	 * @param iComponent
	 */
	public abstract void perform(EComponent iComponent);
	//TODO: Consider moving the component out as event configuration
	
	/**
	 * Check if the event is supported by a <code> GComponent </code>
	 * 
	 * <p>
	 * 
	 * @param iComponent
	 * @return <code> true </code> if the event is supported by the component
	 */
	public abstract boolean isSupportedBy(EComponent iComponent);

	/**
	 * Get type of event
	 * 
	 * <p>
	 * 
	 * @param iComponent
	 * @return
	 */
	public abstract String getType(EComponent iComponent);

}
